[Snyk] Security upgrade @backstage/theme from 0.0.0-use.local to 0.1.1 #10457
Conversation
The following vulnerabilities are fixed with an upgrade: - https://snyk.io/vuln/SNYK-JS-DIFF-14917201 - https://snyk.io/vuln/SNYK-JS-BACKSTAGEBACKENDPLUGINAPI-15054291
Review or Edit in CodeSandboxOpen the branch in Web Editor • VS Code • Insiders |
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub. |
|
Warning Review the following alerts detected in dependencies. According to your organization's Security Policy, it is recommended to resolve "Warn" alerts. Learn more about Socket for GitHub.
|
![entelligence-ai-pr-reviews[bot]](https://avatars.githubusercontent.com/in/932812?s=60&v=4){kind=small}
There was a problem hiding this comment.
Walkthrough
This PR updates the dependency management for the xcmetrics plugin by changing the @backstage/theme package from a workspace reference to a pinned version. The change moves from using workspace:^ (which references the local monorepo workspace version) to a specific locked version 0.1.1. This modification ensures version stability and predictable behavior by preventing automatic updates to the theme package. The change affects how the plugin resolves its theme dependency and may be necessary for maintaining compatibility with a specific theme API version or ensuring consistent behavior across different environments.
Changes
| File(s) | Summary |
|---|---|
plugins/xcmetrics/package.json |
Changed @backstage/theme dependency from workspace reference (workspace:^) to pinned version (0.1.1) for version stability. |
Sequence Diagram
This diagram shows the interactions between components:
sequenceDiagram
participant Dev as Developer
participant PM as Package Manager
participant WS as Workspace
participant NPM as NPM Registry
participant XC as xcmetrics Plugin
Dev->>PM: Update package.json dependency
Note over Dev,PM: Change @backstage/theme<br/>from workspace:^ to 0.1.1
Dev->>PM: Run install command
alt Before Change (workspace:^)
PM->>WS: Resolve @backstage/theme
WS-->>PM: Return local workspace version
PM->>XC: Link workspace theme package
else After Change (0.1.1)
PM->>NPM: Fetch @backstage/theme@0.1.1
NPM-->>PM: Return published version 0.1.1
PM->>XC: Install specific version from registry
end
PM-->>Dev: Dependencies resolved
Note over XC: Plugin now uses pinned<br/>theme version 0.1.1
Install the extension
Note for Windsurf
Please change the default marketplace provider to the following in the windsurf settings:Marketplace Extension Gallery Service URL: https://marketplace.visualstudio.com/_apis/public/gallery
Marketplace Gallery Item URL: https://marketplace.visualstudio.com/items
Entelligence.ai can learn from your feedback. Simply add 👍 / 👎 emojis to teach it your preferences. More shortcuts below
Emoji Descriptions:
⚠️ Potential Issue - May require further investigation.- 🔒 Security Vulnerability - Fix to ensure system safety.
- 💻 Code Improvement - Suggestions to enhance code quality.
- 🔨 Refactor Suggestion - Recommendations for restructuring code.
- ℹ️ Others - General comments and information.
Interact with the Bot:
- Send a message or request using the format:
@entelligenceai + *your message*
Example: @entelligenceai Can you suggest improvements for this code?
- Help the Bot learn by providing feedback on its responses.
@entelligenceai + *feedback*
Example: @entelligenceai Do not comment on `save_auth` function !
Also you can trigger various commands with the bot by doing
@entelligenceai command
The current supported commands are
config- shows the current configretrigger_review- retriggers the review
More commands to be added soon.
| "@backstage/core-components": "workspace:^", | ||
| "@backstage/core-plugin-api": "workspace:^", | ||
| "@backstage/errors": "workspace:^", | ||
| "@backstage/theme": "workspace:^", | ||
| "@backstage/theme": "0.1.1", | ||
| "@material-ui/core": "^4.12.2", | ||
| "@material-ui/icons": "^4.9.1", | ||
| "@material-ui/lab": "4.0.0-alpha.61", |
There was a problem hiding this comment.
Correctness: @backstage/theme changed from workspace:^ to pinned 0.1.1 while all other @backstage/* deps use workspace:^. This forces an outdated version instead of the local workspace package, causing type mismatches and runtime errors. Fix: revert to "@backstage/theme": "workspace:^".
🤖 AI Agent Prompt for Cursor/Windsurf
📋 Copy this prompt to your AI coding assistant (Cursor, Windsurf, etc.) to get help fixing this issue
File: plugins/xcmetrics/package.json, Line 29
Problem: The dependency `@backstage/theme` has been changed from `workspace:^` to a fixed version `0.1.1`, breaking the monorepo workspace protocol. This causes the plugin to use an outdated pinned version instead of the local workspace package, creating version inconsistencies.
Fix: Revert the change to restore the workspace protocol:
- Change `"@backstage/theme": "0.1.1"` back to `"@backstage/theme": "workspace:^"`
- Ensure consistency with other `@backstage/*` dependencies in the same file (lines 26-28) which all use `workspace:^`
- Run `yarn install` or equivalent package manager command after the change to update lockfiles
✨ Committable Code Suggestion
💡 This is a one-click fix! Click "Commit suggestion" to apply this change directly to your branch.
| "@backstage/core-components": "workspace:^", | |
| "@backstage/core-plugin-api": "workspace:^", | |
| "@backstage/errors": "workspace:^", | |
| "@backstage/theme": "workspace:^", | |
| "@backstage/theme": "0.1.1", | |
| "@material-ui/core": "^4.12.2", | |
| "@material-ui/icons": "^4.9.1", | |
| "@material-ui/lab": "4.0.0-alpha.61", | |
| "dependencies": { | |
| "@backstage/core-components": "workspace:^", | |
| "@backstage/core-plugin-api": "workspace:^", | |
| "@backstage/errors": "workspace:^", | |
| "@backstage/theme": "workspace:^", | |
| "@material-ui/core": "^4.12.2", | |
| "@material-ui/icons": "^4.9.1", | |
| "@material-ui/lab": "4.0.0-alpha.61", |
Snyk has created this PR to fix 2 vulnerabilities in the yarn dependencies of this project.
Snyk changed the following file(s):
plugins/xcmetrics/package.jsonNote for zero-installs users
If you are using the Yarn feature zero-installs that was introduced in Yarn V2, note that this PR does not update the
.yarn/cache/directory meaning this code cannot be pulled and immediately developed on as one would expect for a zero-install project - you will need to runyarnto update the contents of the./yarn/cachedirectory.If you are not using zero-install you can ignore this as your flow should likely be unchanged.
Vulnerabilities that will be fixed with an upgrade:
SNYK-JS-DIFF-14917201
SNYK-JS-BACKSTAGEBACKENDPLUGINAPI-15054291
Important
Note: You are seeing this because you or someone else with access to this repository has authorized Snyk to open fix PRs.
For more information:
🧐 View latest project report
📜 Customise PR templates
🛠 Adjust project settings
📚 Read about Snyk's upgrade logic
Learn how to fix vulnerabilities with free interactive lessons:
🦉 Regular Expression Denial of Service (ReDoS)
EntelligenceAI PR Summary
This PR locks the @backstage/theme dependency to a specific version in the xcmetrics plugin for improved version stability.
workspace:^to pinned version0.1.1plugins/xcmetrics/package.json